gridpack::powerflow::PFBranch Class Reference

#include <pf_components.hpp>

Inheritance diagram for gridpack::powerflow::PFBranch:

[legend]

Collaboration diagram for gridpack::powerflow::PFBranch:

[legend]

List of all members.

Public Member Functions
	PFBranch (void)
	~PFBranch (void)
bool	matrixForwardSize (int *isize, int *jsize) const
bool	matrixReverseSize (int *isize, int *jsize) const
bool	matrixForwardValues (ComplexType *values)
bool	matrixReverseValues (ComplexType *values)
bool	matrixForwardValues (RealType *values)
bool	matrixReverseValues (RealType *values)
void	setYBus (void)
gridpack::ComplexType	getYBus (void)
void	load (const boost::shared_ptr< gridpack::component::DataCollection > &data)
void	getJacobian (PFBus *bus, double *values)
void	getPQ (PFBus *bus, double *p, double *q)
void	setMode (int mode)
gridpack::ComplexType	getComplexPower (std::string tag)
bool	serialWrite (char *string, const int bufsize, const char *signal=NULL)
bool	getBranchStatus (std::string tag)
void	setBranchStatus (std::string tag, bool status)
double	getBranchRatingA (std::string tag)
double	getBranchRatingB (std::string tag)
double	getBranchRatingC (std::string tag)
std::vector< std::string >	getLineIDs ()
void	setIgnore (std::string tag, bool flag)
bool	getIgnore (std::string tag)
int	forwardJacobianValues (double *rvals)
int	reverseJacobianValues (double *rvals)

---

Constructor & Destructor Documentation

gridpack::powerflow::PFBranch::PFBranch

(

void

)

Simple constructor

gridpack::powerflow::PFBranch::~PFBranch

(

void

)

Simple destructor

---

Member Function Documentation

int gridpack::powerflow::PFBranch::forwardJacobianValues

(

double *

rvals

)

Evaluate off-diagonal block of Jacobian for power flow calculation and return result as an array of real values

Parameters:

rvals

values of Jacobian block

Returns:

number of values returned

double gridpack::powerflow::PFBranch::getBranchRatingA

(

std::string

tag

)

get branch rating A value

Parameters:

tag

transmission element ID

Returns:

branch rating value

double gridpack::powerflow::PFBranch::getBranchRatingB

(

std::string

tag

)

get branch rating B value

Parameters:

tag

transmission element ID

Returns:

branch rating value

double gridpack::powerflow::PFBranch::getBranchRatingC

(

std::string

tag

)

get branch rating C value

Parameters:

tag

transmission element ID

Returns:

branch rating value

bool gridpack::powerflow::PFBranch::getBranchStatus

(

std::string

tag

)

Get the status of the branch element

Parameters:

tag

character string identifying branch element

Returns:

status of branch element

gridpack::ComplexType gridpack::powerflow::PFBranch::getComplexPower

(

std::string

tag

)

Return complex power for line element

Parameters:

tag

describing line element on branch

Returns:

complex power

bool gridpack::powerflow::PFBranch::getIgnore

(

std::string

tag

)

Get parameter to ignore voltage violations

Parameters:

tag

identifier of line element

Returns:

value of ignore parameter

void gridpack::powerflow::PFBranch::getJacobian	(	PFBus *	bus,
		double *	values
	)

Return the contribution to the Jacobian for the powerflow equations from a branch

Parameters:

	bus,:	pointer to the bus making the call
	values,:	an array of 4 doubles that holds return metrix elements

Returns:

: contribution to Jacobian matrix from branch

std::vector<std::string> gridpack::powerflow::PFBranch::getLineIDs

(

)

Get list of line IDs

Returns:

list of line identifiers

void gridpack::powerflow::PFBranch::getPQ	(	PFBus *	bus,
		double *	p,
		double *	q
	)

Return contribution to constraints

Parameters:

	p,:	real part of constraint
	q,:	imaginary part of constraint

gridpack::ComplexType gridpack::powerflow::PFBranch::getYBus

(

void

)

Get values of YBus matrix. These can then be used in subsequent calculations

void gridpack::powerflow::PFBranch::load

(

const boost::shared_ptr< gridpack::component::DataCollection > &

data

)

[virtual]

Load values stored in DataCollection object into PFBranch object. The DataCollection object will have been filled when the network was created from an external configuration file

Parameters:

data,:

DataCollection object contain parameters relevant to this branch that were read in when network was initialized

Reimplemented from gridpack::ymatrix::YMBranch.

bool gridpack::powerflow::PFBranch::matrixForwardSize	(	int *	isize,
		int *	jsize
	)			const [virtual]

Return size of off-diagonal matrix block contributed by the component for the forward/reverse directions

Parameters:

isize,jsize,:

number of rows and columns of matrix block

Returns:

: false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBranch.

bool gridpack::powerflow::PFBranch::matrixForwardValues

(

RealType *

values

)

[virtual]

Reimplemented from gridpack::component::MatVecInterface.

bool gridpack::powerflow::PFBranch::matrixForwardValues

(

ComplexType *

values

)

[virtual]

Return the values of the forward/reverse matrix block. The values are returned in row-major order

Parameters:

values,:

pointer to matrix block values

Returns:

: false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBranch.

bool gridpack::powerflow::PFBranch::matrixReverseSize	(	int *	isize,
		int *	jsize
	)			const [virtual]

Return size of off-diagonal matrix block contributed by component. The values are for the reverse direction.

Parameters:

isize,jsize

number of rows and columns of matrix block

Returns:

false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBranch.

bool gridpack::powerflow::PFBranch::matrixReverseValues

(

RealType *

values

)

[virtual]

Reimplemented from gridpack::component::MatVecInterface.

bool gridpack::powerflow::PFBranch::matrixReverseValues

(

ComplexType *

values

)

[virtual]

Return the values for an off-diagonl matrix block. The values are for the reverse direction and are returned in row-major order.

Parameters:

values

pointer to matrix block values

Returns:

false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBranch.

int gridpack::powerflow::PFBranch::reverseJacobianValues

(

double *

rvals

)

bool gridpack::powerflow::PFBranch::serialWrite	(	char *	string,
		const int	bufsize,
		const char *	signal = NULL
	)			[virtual]

Write output from branches to standard out

Parameters:

	string	(output) string with information to be printed out
	bufsize	size of string buffer in bytes
	signal	an optional character string to signal to this routine what about kind of information to write

Returns:

true if branch is contributing string to output, false otherwise

Reimplemented from gridpack::component::BaseComponent.

void gridpack::powerflow::PFBranch::setBranchStatus	(	std::string	tag,
		bool	status
	)

Set the status of the branch element

Parameters:

	tag	character string identifying branch element
	status	status of branch element

void gridpack::powerflow::PFBranch::setIgnore	(	std::string	tag,
		bool	flag
	)

Set parameter to ignore voltage violations

Parameters:

	tag	identifier of line element
	flag	value of ignore parameter

void gridpack::powerflow::PFBranch::setMode

(

int

mode

)

[virtual]

Set the mode to control what matrices and vectors are built when using the mapper

Parameters:

mode,:

enumerated constant for different modes

Reimplemented from gridpack::ymatrix::YMBranch.

void gridpack::powerflow::PFBranch::setYBus

(

void

)

Set values of YBus matrix. These can then be used in subsequent calculations

Reimplemented from gridpack::ymatrix::YMBranch.

---

The documentation for this class was generated from the following file:

• pf_components.hpp